Skip to content

docs(memcached): sync template standards updates#358

Merged
mberlofa merged 3 commits into
mainfrom
docs/memcached-template-standards-sync
Jul 6, 2026
Merged

docs(memcached): sync template standards updates#358
mberlofa merged 3 commits into
mainfrom
docs/memcached-template-standards-sync

Conversation

@mberlofa

@mberlofa mberlofa commented Jul 4, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Document networkPolicy.extraEgress for Memcached.
  • Add Memcached playground controls for custom egress CIDR and port.

Related

Validation

  • npm run lint
  • npm run format:check
  • npm run build
  • make site-sync-check CHART=memcached
  • make release-check REPO=site
  • make attribution-check REPO=site

Summary by CodeRabbit

  • New Features
    • Enhanced the Memcached chart’s Network Policy configuration to support adding extra outbound access via an additional egress CIDR and port.
    • Updated the Memcached documentation with a Production example showing how to append custom egress entries, and added a configuration reference for the new extraEgress option.

@coderabbitai

coderabbitai Bot commented Jul 4, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: d61dd2d4-e1c1-42b4-b34b-9d49bb5040fa

📥 Commits

Reviewing files that changed from the base of the PR and between 06c5e67 and 7c84acc.

📒 Files selected for processing (2)
  • src/data/playground-configs.ts
  • src/pages/docs/charts/memcached.mdx
✅ Files skipped from review due to trivial changes (1)
  • src/pages/docs/charts/memcached.mdx
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/data/playground-configs.ts

📝 Walkthrough

Walkthrough

Added two configurable playground fields for memcached networkPolicy.egress.extraEgress[0], and updated the memcached chart docs to show extraEgress in the production example and configuration reference.

Changes

Memcached NetworkPolicy extraEgress

Layer / File(s) Summary
Playground config fields
src/data/playground-configs.ts
Added an "Extra Egress CIDR" text field and an "Extra Egress Port" numeric field for networkPolicy.egress.extraEgress[0].
Documentation update
src/pages/docs/charts/memcached.mdx
Added extraEgress to the deployment example and documented networkPolicy.egress.extraEgress in the configuration reference.

Estimated code review effort: 2 (Simple) | ~10 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly reflects the memcached docs/playground sync for template standards updates.
Description check ✅ Passed The description covers the summary, related change, and validation, but it does not follow the template’s Quality Gates and Related Issue sections exactly.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/memcached-template-standards-sync

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (1)
src/pages/docs/charts/memcached.mdx (1)

236-243: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low value

Consider showing a populated extraEgress example.

extraEgress: [] just repeats the default and doesn't demonstrate the rule shape (to[].ipBlock.cidr, ports[].port) that the new playground fields populate.

✏️ Suggested example
   egress:
     enabled: true
     allowDNS: true
-  extraEgress: []
+  extraEgress:
+    - to:
+        - ipBlock:
+            cidr: 10.80.0.0/16
+      ports:
+        - port: 443
+          protocol: TCP
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@src/pages/docs/charts/memcached.mdx` around lines 236 - 243, The
NetworkPolicy example in the memcached docs only shows the default empty
extraEgress value, so update the example to demonstrate a populated extraEgress
rule using the fields exposed by the playground, such as a to[] ipBlock.cidr
target and ports[] entries with port values. Keep the surrounding networkPolicy
structure in the memcached.mdx example, but replace the placeholder empty array
with a concrete rule shape that readers can copy.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Nitpick comments:
In `@src/pages/docs/charts/memcached.mdx`:
- Around line 236-243: The NetworkPolicy example in the memcached docs only
shows the default empty extraEgress value, so update the example to demonstrate
a populated extraEgress rule using the fields exposed by the playground, such as
a to[] ipBlock.cidr target and ports[] entries with port values. Keep the
surrounding networkPolicy structure in the memcached.mdx example, but replace
the placeholder empty array with a concrete rule shape that readers can copy.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 64bba44c-9902-45a7-8156-d034102734c7

📥 Commits

Reviewing files that changed from the base of the PR and between 365449a and ad54364.

📒 Files selected for processing (2)
  • src/data/playground-configs.ts
  • src/pages/docs/charts/memcached.mdx

@mberlofa

mberlofa commented Jul 5, 2026

Copy link
Copy Markdown
Contributor Author

Synced this site PR with the Memcached chart change in helmforgedev/charts#680.

What changed:

  • Updated the Memcached docs example and configuration reference from networkPolicy.extraEgress to networkPolicy.egress.extraEgress.
  • Updated the playground field keys to generate the nested value path.

Validation:

  • make site-sync-check CHART=memcached reports the required artifacts as OK.
  • npm run format:check passed.
  • npm run lint passed.
  • npm run build passed.
  • make release-check REPO=site passed.
  • make attribution-check REPO=site passed.

@mberlofa

mberlofa commented Jul 6, 2026

Copy link
Copy Markdown
Contributor Author

Addressed the CodeRabbit review-body feedback.

Changes:

  • Replaced the empty Memcached networkPolicy.egress.extraEgress placeholder with a populated rule showing the to[].ipBlock.cidr and ports[] shape used by the playground controls.
  • Verified this path against the paired charts PR, fix(memcached): align template standards charts#680, where networkPolicy.egress.extraEgress is introduced.

Validation:

  • npm run lint passed
  • npm run build passed
  • make site-sync-check CHART=memcached passed
  • make release-check REPO=site passed
  • make attribution-check REPO=site passed
  • git diff --check passed

Note: this CodeRabbit item was posted in the review summary/body, not as an active review thread, so there is no thread ID to reply to or resolve.

mberlofa added a commit to helmforgedev/charts that referenced this pull request Jul 6, 2026
## Summary
- Keep the Helm test hook under `templates/tests/` so `helm test`
renders and executes it, with unittest coverage preserved.
- Add `networkPolicy.extraEgress` so callers can append full custom
egress rules.
- Number `NOTES.txt` sections and sync README values documentation.

## Related
- Site sync: helmforgedev/site#358.

## Validation
- `helm template test charts/memcached | rg -n
"helm.sh/hook|test-connection"` (hook rendered from
`templates/tests/test-connection.yaml`)
- `helm unittest charts/memcached` (41 tests, 9 suites)
- `make template-standards-check CHART=memcached`
- `node scripts/charts/validate-chart.js --chart memcached --no-k3d`
- `make validate-chart CHART=memcached TIMEOUT=900` (FULLY VALIDATED, 19
layers)

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **New Features**
* Added `networkPolicy.egress.extraEgress` to append additional egress
rules to Memcached NetworkPolicy.
* **Bug Fixes**
* NetworkPolicy rendering now includes the extra egress rules when
configured (covered by rendering tests).
* **Documentation**
* Updated Memcached chart docs and NetworkPolicy examples to describe
`networkPolicy.extraEgress`.
* Improved startup notes formatting and validation instructions with
clearer numbered sections.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: MergeCheck <mergecheck@example.invalid>
@mberlofa mberlofa force-pushed the docs/memcached-template-standards-sync branch from 06c5e67 to 7c84acc Compare July 6, 2026 15:37
@mberlofa mberlofa merged commit 44f1ceb into main Jul 6, 2026
6 checks passed
@mberlofa mberlofa deleted the docs/memcached-template-standards-sync branch July 6, 2026 15:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant